home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDITOR / FUGUE_3.ARJ / WF.015 < prev    next >
Text File  |  1991-01-17  |  7KB  |  176 lines
  1. .f3                              - # -              Chapter 15 - Indexing
  2. .rm70
  3. .mt5
  4. .mb5
  5. .pl66
  6. .tc
  7. .tc 15. INDEXING ..........................................#
  8. CHAPTER 15   INDEXING
  9.  
  10. .IMIndexing
  11. An index is an alphabetic listing of topics in the text, each with a
  12. list of page numbers where the phrase can be found. Word Fugue can
  13. create document indexes.
  14.  
  15. .tc    Specifying Index Entries ...........................#
  16. Specifying Index Entries
  17.  
  18. .ix  Marking with .IX command
  19. .ix  Marking with ^K command
  20. .ix  Specifying index entries
  21. Individual words and phrases can be marked in the text by pressing Ctl
  22. P K before and after the phrase you want to include in the index.
  23. For example:
  24.  
  25.       This paragraph explains about ^K indexing documents^K
  26.  
  27. The bracketing ^Ks do not print, they are only there to mark an index
  28. entry. Any characters between the two markers will be included in the
  29. index when it is generated.
  30.  
  31. You can also enter a word or phrase by using the .IX dot command. The
  32. dot must appear in the first column. For example:
  33.  
  34.         .IX indexing documents
  35.  
  36. In either case, the maximum length of an index phrase is 50
  37. characters, and is counted from the first character following the .ix
  38. or the ^K. Extra characters are ignored. In each case, the same phrase
  39. indexing documents will be included in the index, with a leading
  40. space.
  41.  
  42. You will be prompted for the name of the file to generate the index
  43. for. If you elect to use the same name as the file you are editing,
  44. Word Fugue will use the disk version of the file.
  45.  
  46. .ix  File name used
  47. The output file name will be that of the input file name, with the
  48. extension set to .IDX
  49.  
  50. .ix  Major heading prefix
  51. To assist sorting of index entries, you can create major headings by
  52. prefixing the index entry by the major heading, followed by a
  53. semicolon ';'. These major sort keys are limited to 14 characters.
  54. When you use major heading, you can still have 50 characters for the
  55. index entry (counted from the first character after the semicolon).
  56.  
  57. .tc    Generating an Index ................................#
  58. Generating an Index
  59.  
  60. .ix  Generation of
  61. Press Ctrl F6 to commence the operation. Word Fugue will prompt you with
  62.  
  63.       Enter file name to index
  64.  
  65. The file name will default to the last entry for editing, and may
  66. contain wild cards if that was how you selected your last file for
  67. editing. When you enter a file name, Word Fugue will generate an index.
  68. If you press enter with wild cards showing ('*' or '?'), you will see
  69. a picklist from which to select your file. You can cancel the
  70. operation by pressing ESC at the prompt. In addition, you can abort
  71. the index operation part way through by pressing the abort command ^U.
  72.  
  73. .CP15
  74. It typically takes about 1 second per page on a slow 4.7Mh IBM or
  75. clone, and the message Working is displayed on the top line. The
  76. generation will use the file(s) on disk, so be sure to save the file
  77. you are editing so that the latest changes will be included in your
  78. index. During generation, each index entry occupies about 80
  79. characters of memory,Thus, if you are editing a large document, you
  80. may run out of memory. In this case, close all files to free up
  81. memory, and do the index operation when you are editing a blank file,
  82. or exit re-enter with an empty file.
  83.  
  84. .ix  Memory usage
  85. .ix  Working with large documents
  86. TIP - if you are writing a book or similar, with several chapters, set
  87.       each chapter up as a separate file, and create a master file
  88.       that includes each chapter, table of contents & index file by
  89.       use of .FI commands. Generate the index for the top level file,
  90.       and all lower level files will be included.
  91.  
  92. .tc    Sample Input and Output ............................#
  93. Sample Input and Output
  94.  
  95. .IMIndexing
  96. .ix  Specifying index entries
  97. Given this simple input:
  98.  
  99.                     .ix Indexing;  Generation
  100.                     .ix Indexing;  Specifying Entries
  101.                     .ix Indexing
  102.  
  103. appearing on several pages of the document, the indexing operation
  104. will produce the following output:
  105.  
  106.                      Indexing
  107.                         2-4,6
  108.                        Generation
  109.                         2-4,6
  110.                        Specifying Entries
  111.                         2-4,6
  112.  
  113. where the figures appearing under the index entries are the page
  114. references. Each entry is sorted alphabetically, but upper and lower
  115. case are ignored. To sort various entries together, you should
  116. prefix them all with the same major heading, as shown above.
  117.  
  118. This process can be made more easy by use of Index Major entries.
  119.  
  120. .tc    Index Major Entries ................................#
  121. Index Major Entries
  122.  
  123. .ix  Marking with .IM command
  124. If you prefer a more tarted up output produced automatically, you can
  125. specify the sort prefix for index entries by use of the .IM command to
  126. set a major heading for index entries. The text following the .IM
  127. command will appear in the index, and will also be used as a sort
  128. prefix for subsequent .IX commands and text between ^K markers. The
  129. same prefix will be used for all index entries until the appearance of
  130. another .IM command.
  131.  
  132. .CP6
  133. The example above could be re-written as:
  134.  
  135.                     .im INDEXING
  136.                     .ix   Specifying Entries
  137.                     .ix   Generation
  138.  
  139. and would produce:
  140.  
  141.                      INDEXING
  142.                         2-4,6
  143.                        Generation
  144.                         2-4,6
  145.                        Specifying Entries
  146.                         2-4,6
  147.  
  148. The difference between this and the previous example using prefixes is
  149. that .IM entries are index entries in their own right, while the major
  150. heading prefixes in .IX and ^K entries do not appear in the index, but
  151. are used merely for sequencing or sorting of the index entries.
  152.  
  153. When using .IM entries, the text is restricted to 50 characters
  154. following the .IM, as for .IX entries. The first 14 characters of the
  155. .IM entry is used for sequencing or sorting, as with the prefix
  156. method.
  157.  
  158. .IMIndexing
  159. .ix  Specifying index entries
  160. You can also include font commands to make the entries bold, italic,
  161. double height or width etc.
  162.  
  163. The format of the output is as shown above - each entry occupies 2
  164. lines, the first for the entry, the second for the page number
  165. references separated by commas. Note that if 3 or more consecutive
  166. page numbers are found, they are abbreviated to the first and last
  167. number, separated by a hyphen.
  168.  
  169. Thus pages 2, 3, 6 and 7 would appear
  170.  
  171.         2,3,6,7
  172.  
  173. while pages 2, 3, 4, 5, 9, 10, 11 and 15 would appear as
  174.  
  175.         2-5,9-11,15
  176.